/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2011, Salzburg Research. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither the name of the KiWi Project nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * Contributor(s):
 * sschaffe
 *
 * File Info:
 * User: sschaffe
 * Date: 2011/01/18
 * Time: 14:07
 *
 * Project: KiWi2, kiwi-core module
 */

package kiwi.core.api.triplestore;

import kiwi.core.model.content.MediaContent;
import kiwi.core.model.content.TextContent;
import kiwi.core.model.rdf.KiWiLiteral;
import kiwi.core.model.rdf.KiWiMediaContentLiteral;
import kiwi.core.model.rdf.KiWiTextContentLiteral;

import java.util.Locale;

/**
 * The LiteralService offers - similar to the ResourceService - methods for creating and removing literal values
 * from the KiWi triple store.
 *
 * <p/>
 * User: sschaffe
 */
public interface LiteralService {


    /**
     * Create a new KiWiLiteral of the provided type.
     * @param <T>
     * @param value
     * @param language
     * @param type
     * @return
     */
    public <T> KiWiLiteral createLiteral(T value, Locale language, String type);

    /**
     * Create a new KiWiLiteral. The type is inferred by Java reflection.
     * @param <T>
     * @param value
     * @return
     */
    public <T> KiWiLiteral createLiteral(T value);

	/**
     * Get existing KiWiLiteral or null. The type is inferred by Java reflection.
     * @param <T>
     * @param value
     * @return
     */
    public <T> KiWiLiteral getLiteral(T value);

	/**
     * Get KiWiLiteral of the provided type, null if it does not exist.
     * @param <T>
     * @param value
     * @param language
     * @param type
     * @return
     */
	public <T> KiWiLiteral getLiteral(T value, Locale language, String type);

    /**
     * Create a new KiWiTextContentLiteral for representing KiWi textual content.
     */
    public KiWiTextContentLiteral createTextContentLiteral(String content, Locale language);


    /**
     * Create a new KiWiTextContentLiteral for representing KiWi textual content.
     */
    public KiWiTextContentLiteral createTextContentLiteral(TextContent content);


    /**
     * Create a new KiWiMediaContentLiteral for representing KiWi media content
     */
    public KiWiMediaContentLiteral createMediaContentLiteral(MediaContent content);



    public void clearCaches();

}
